home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / wchslinm.zip / WCHS.DOC < prev    next >
Text File  |  1992-02-02  |  12KB  |  257 lines
  1. Wildcat-HSlink utility.  (c) 1992  Karl Schneider
  2.                                    8505 Woodwick Ct.
  3.                                    Tampa, FL 33615
  4.                                    813-884-9661 voice days/eves
  5.                                    "   "   "    BBS midnight to 0700 EST
  6. For WILDCAT 3.x+(c) and HSLINK(c)               14.4 HST
  7.  
  8. >>> PLEASE READ THIS FILE CAREFULLY BEFORE/WHILE INSTALLING. <<<
  9. >>> ALSO, PLEASE SEE THE READ.ME FILE IN THIS ARCHIVE <<<
  10.  
  11. These files should be in WCHSLINK.ZIP:
  12.  
  13. DESC.SDI      Description for automatic desc progs like AUTODESC
  14. HISTORY       Revision history of WCHSLINK, latest listed first
  15. POSTCALL.BAT  Sample POSTCALL file
  16. RH.BAT        Sample UPload batch file
  17. SH.BAT        Sample DOWNload batch file
  18. WC3UTILS.LST  List of all my WC3 utility programs
  19. WCHS.DOC      This Document/Instruction file
  20. WCHSCK.EXE    Program to test for uncompleted HSLINK transfers
  21. WCHSD.EXE     Download converter program
  22. WCHSU1.EXE    Upload converter program #1
  23. WCHSU2.EXE    Upload converter program #2
  24. QBEW.ZIP      Utilities to let Qmodem's BEW work with HSLINK, DSZ, etc.
  25. ------------------------------------------------------------------------
  26. Shareware release:  This version ONLY SUPPORTS COM1 AND COM2.* The
  27. REGISTERED version supports COM3 and up, is DESQview optimized **,
  28. offers a few more features such as the ability to automatically create
  29. a USERx.BBS notice to anyone who fails to complete (add file descrip-
  30. tions, etc.) after a Bidirectional HSLINK transfer.  Note, however,
  31. the programs in this release are NOT CRIPPLED, have no 'time-bombs',
  32. and do not write any 'secret' files or write into any existing Wildcat
  33. or other system or program files.  See 'REGISTRATION' at the end of
  34. this file.
  35.  
  36. *  If you use COM3 or COM4 with 'standard' addresses and IRQs, the
  37.    program may work properly.  Try it and see.
  38. ** This version will run fine in DV, but is not optimized for it.
  39. -------------------------------------------------------------------------
  40. HSLINK (c) is a widely distributed and frequently updated Beta of a bi-
  41. directional (as well as one-way) high speed file transfer protocol writ-
  42. ten by Samuel Smith.  The first non-Beta versioin has just been re-
  43. leased as HSLINK10.ZIP (1/14/92).  If you plan to offer this protocol, be
  44. sure to try to keep the latest version installed. Note that HSLINK
  45. does not perform very well on a USR HST modem, since its backchannel
  46. is slow...but it _will_ work.  Some comments have been floating around
  47. saying it can NOT be used with an HST but that's not correct.
  48. --------------------------------------------------------------------------
  49.  
  50. The programs in this archive will enable you to use HSLINK for
  51. regular (one-way) *AND BIDIRECTIONAL* transfers to and from your Wildcat
  52. 3.x+ BBS.  The implementation is not quite 'perfect' in that it requires
  53. your users to perform ONE ADDITIONAL STEP after doing a two-way
  54. transfer.  It is, however, quite simple, and the users are CLEARLY
  55. INSTRUCTED how to go about it by the enclosed program WCHSD.EXE.
  56.  
  57. >> Please read these instructions carefully---the setup is NOT
  58. >> complicated, but it MUST be followed properly.  You MUST USE the
  59. >> directory paths specified in the included .BAT files for the programs
  60. >> to work correctly!
  61.  
  62. First, let me explain how your users will do a BIDIRECTIONAL file
  63. transfer.  The first step is just as explained in the HSLink Documents;
  64. that is, the user picks the file(s) he wishes to DOWNload from the Files
  65. Menu as usual, chooses [H]slink (or whatever letter you have set up
  66. in Makewild), and when Wildcat instructs him to begin the download,
  67. he initiates an UPLOAD using HsLink from his usual COMM program, after
  68. telling it what file(s) to SEND (upload) to your BBS.
  69.  
  70. HSLINK will perform the transfers, and when it is finished, your SH.BAT
  71. file (or whatever it's named) will call the program WCHSD.EXE which
  72. will check to see if HSLINK RECEIVED any files (UPloads to your sys-
  73. tem, that is)...and if so, will instruct the user to COMPLETE THE
  74. OPERATION by entering [U] from the Files menu when it reappears, then
  75. selecting HSLink and WAIT for the prompts: 'Do you wish to password
  76. protect this file', 'Enter Description', and so forth.  He will be
  77. told NOT TO INITIATE ANOTHER UPLOAD AT THAT TIME - ONLY TO WAIT FOR
  78. THE PROMPTS ASKING FOR THE FILE INFORMATION!
  79.  
  80. You will see this same message on your BBS screen.  The user will
  81. have 30 seconds to 'press a key', which should be sufficient to under-
  82. stand the instructions.  If he does not press a key, Wildcat will
  83. restart anyway after 30 secs.
  84.  
  85. After descriptions, etc. have been entered for all files, WILDCAT will
  86. go through the normal SCANFILE testing routine for the uploads, just
  87. as in a NORMAL UPLOAD.  (Since you probably use something like ZIPLAB (c),
  88. CATSCAN (c), etc.  Note that AUTODESC, my automatic description in-
  89. serting program, DOES function properly in this procedure).
  90.  
  91. Here are some possible problems that may arise:
  92.  
  93. 1.  The user attempts to UPLOAD files again after the HSLINK
  94.     transfer is complete.  This will result in incoming binary
  95.     data which will probably cause WILDCAT to do who knows what.
  96.     You have all seen this...different menus coming up, etc. etc...
  97.     caused, of course, by a protocol sending (usually compressed) data
  98.     not intended to answer prompts from Wildcat or be inserted into
  99.     file descriptions. If, however, he DOES finish the pro-
  100.     cedure properly, he can then successfully upload and/or download
  101.     more files using any supported protocol.
  102.  
  103.     This will not cause any serious problem, but the uploads may
  104.     be lost, have wrong descriptions, or the user may just get
  105.     frightened by the furious activity caused by sending nonsense to
  106.     Wildcat, and hang up.  I suggest posting a bulletin or Hello
  107.     screen with some instructions for doing HSLink transfers.
  108.  
  109. 2.  The user fails to complete the transfer procedure...that is,
  110.     does not select [U]pload and enter the information for the files
  111.     he has already sent.
  112.  
  113.     (Note that this works a little differently with WC 3.01 and 3.02:
  114.     In 3.01, it will 'accept' the 'uploads', THEN ask for the 'pass-
  115.     word', 'description', etc.  With 3.02, it will want this infor-
  116.     mation FIRST---and then will complete the 'upload'...and will
  117.     function normally even if more files are found than were described!)
  118.  
  119.     If he LOGS OFF BEFORE DOING THIS (Actually, he can EXIT THE FILES
  120.     MENU and do OTHER THINGS, then come BACK and do the 'Upload' just
  121.     fine!), the HS uploads will be moved into a designated 'hold'
  122.     directory and a note will be put into the appropriate ACTIVITY.00x
  123.     log file notifying you that he did not complete the procedure.
  124.     You can do whatever you like with the uploaded files afterwards;
  125.     they will be intact in your 'hold' directory.
  126. ------------------------------------------------------------------------
  127.  
  128. OK....now how to set all this up?
  129.  
  130. Let's take it step by step -- (5 steps) - you gotta do 'em all!
  131.  
  132. 1.  Starting from your Wildcat HOME directory, in DOS, type the
  133.     following:
  134.  
  135.     md wcwork\node#\ep\temp
  136.  
  137.     Replace the '#' above with the NODE NUMBER you are installing
  138.     this package in.
  139.  
  140.     If you are installing it in more than 1 node, REPEAT the above
  141.     command with the appropriate node numbers.
  142.  
  143.     If you have NEVER installed EXTERNAL PROTOCOLS, you may get a DOS
  144.     message like 'unable to create directory'.  In this case you will
  145.     probably need to first enter:
  146.  
  147.     md wcwork\node#\ep
  148.                   ^same as above for the Node #
  149.  
  150.     To create the \ep directory, then create the \temp dir under \ep
  151.     as above.
  152.  
  153. 2.  Now put all 4 of the .EXE files in this archive (WCHSD.EXE,
  154.     WCHSU1.EXE, WCHSU2.EXE, and WCHSCK.EXE) someplace in your DOS
  155.     PATH.
  156.  
  157. 3.  Be sure your WCNODEID=   Environment variable is properly set
  158.     for each node using this package. (page 278 in my manual).
  159.     THIS IS REQUIRED.
  160.  
  161. 4.  Set up HSLINK as an External Protocol in Makewild.  I use SH.BAT
  162.     as the Download (Send) batch file, and RH.BAT for UPloads (Receive).
  163.     Set 'batch transfers' to Yes.
  164.  
  165.     Sample batch files are included in this archive.  Make them
  166.     EXACTLY AS SHOWN in the included examples except as noted below.
  167.     Remember that these batch files go in your Wildcat HOME DIRECTORY.
  168.     Here are copies:
  169.  
  170. --------------------------------------------------------------------------
  171. REM THIS IS SH.BAT
  172. REM download from Wildcat 3.x+
  173. HSLINK -P%2 -E%4 -A -R -HS -NV -Uc:\wc30\wcwork\node%WCNODEID%\ep\temp %5
  174. if errorlevel 1 goto bad
  175. goto ok
  176. :bad
  177. copy d:\wc30\all.ok transfer.bad
  178. goto end
  179. :ok
  180. wchsd %1 %2
  181. :end
  182. --------------------------------------------------------------------------
  183. You will need to adjust the pathnames in lines 3 and 7
  184. depending on your WC setup drive\dir, etc.  Check the HS Docs for
  185. info on the HSLINK command line parameters.  Take out the REMs and/or
  186. add 'echo off' at the top, if you prefer.  Be sure you have an 'ALL.OK'
  187. file in the proper place (or, you can use another existing file
  188. pathname, just so WILDCAT can detect a TRANSFER.BAD file in the \ep
  189. directory when a transfer fails).
  190. ===========================================================================
  191.  
  192. REM THIS IS RH.BAT
  193. REM upload to Wildcat 3.x+
  194. wchsu1
  195. if errorlevel 1 goto skip
  196. hslink -P%2 -E%4 -A -R -HS -NV -Ud:\wc30\wcwork\node%WCNODEID%\ep
  197. goto end
  198. :skip
  199. wchsu2
  200. :end
  201.  
  202. ----------------------------------------------------------------------------
  203. The only changes that will be needed here are the paths to your \ep
  204. directory.  Refer to the HS Docs for further info.
  205. Ditto as above for SH.BAT concerning REMs and 'echo off', etc.
  206. ===========================================================================
  207.  
  208. 5.  Create or edit a POSTCALL.BAT file, in your WC HOME DIRECTORY to
  209.     contain the following line:
  210.  
  211.     wchsck c:wc30\hold
  212.            ^^|^^^^^^^^
  213.              This is the drive\directory where UNCOMPLETED HSLINK
  214.              UPLOADS are to be MOVED to.  A note in your ACTIVITY.00x
  215.              file will inform you when this is done.  If the directory
  216.              does not exist, WCHSCK will create it for you.  Note that
  217.              the files will NOT BE IN YOUR WILDCAT FILES DATABASE and
  218.              the user who sent them will NOT BE CREDITED FOR THEM!
  219.  
  220. End of Installation steps.
  221. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  222. NOTES:
  223.  
  224. Regular Downloads and Uploads (One-way transfers) are handled in
  225. the normal way...NO extra steps are required for the user.
  226.  
  227. In summary, the only thing different required of the USER is:
  228. After doing a BIDIRECTIONAL transfer, he needs to do [U]pload
  229. from the [F]iles Menu, select [H]Slink, and simply WAIT (just a few
  230. seconds) until Wildcat asks for the 'password protect', 'Description',
  231. etc.  The WCHSD program will specifically instruct him to do this.
  232.  
  233. No special procedures are required for you, the SYSOP, other than
  234. monitoring your 'hold' directory for 'uncompleted' uploads, and possibly
  235. communicating with the uploader to explain the correct procedure.  If
  236. you choose to register this program, you will get another quick little
  237. program that will automatically create a USERx.BBS file for anyone who
  238. fails to complete the file descriptions, etc.
  239. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  240. This package is running on several 3.01 and 3.02 systems and so far has
  241. not produced any problems, but as with any software that must run in
  242. many different environments, some bugs are possible.  I make no war-
  243. ranties that these programs will perform properly in all installations,
  244. and welcome any bug reports or suggestions.
  245.  
  246. REGISTRATION:
  247.  
  248. This package may be used for a reasonable period not to exceed 30
  249. days from its installation for evaluation.  If you continue to use
  250. it afterward, a $10 registration to the above address is required.
  251. A payment of $25 or more will constitute registration to this package
  252. PLUS ALL of my other WC3 utilities!  Registration of course entitles
  253. you to full phone/bbs support and even customization you may wish,
  254. within reason.  Thank you!
  255.  
  256. -eof-
  257.